HL7 FHIR Implementation Guide: ZM-Core Release 1 - Zambia
​0.1.0 - Zambia flag

HL7 FHIR Implementation Guide: ZM-Core Release 1 - Zambia - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: ZM-Core Communication Subscription Topic Profile

Official URL: http://hapi.moh.gov.zm/fhir/StructureDefinition/zm-core-communication-subscription-topic Version: 0.1.0
Active as of 2026-08-12 Computable Name: ZMCoreCommunicationSubscriptionTopic

A governed R5 subscription topic that describes which communication events may activate hub workflows and what may be filtered or returned.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots, and their representations.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. SubscriptionTopic 0..* SubscriptionTopic The definition of a specific topic for triggering events within the Subscriptions framework
Interfaces Implemented: CanonicalResource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... version SΣ 0..1 string Business version of the subscription topic
... name SΣ 1..1 string Name for this subscription topic (computer friendly)
... title SΣ 1..1 string Name for this subscription topic (human friendly)
... status ?!SΣ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
... experimental SΣ 0..1 boolean If for testing purposes, not real usage
... date SΣ 0..1 dateTime Date status first applied
... publisher SΣ 0..1 string The name of the individual or organization that published the SubscriptionTopic
... description S 1..1 markdown Natural language description of the SubscriptionTopic
... jurisdiction SΣ 0..* CodeableConcept Intended jurisdiction of the SubscriptionTopic (if applicable)
Binding: JurisdictionValueSet (extensible): Countries and regions within which this artifact is targeted for use.
... purpose S 0..1 markdown Why this SubscriptionTopic is defined
... resourceTrigger SΣ 1..* BackboneElement Definition of a resource-based trigger for the subscription topic
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... resource SΣ 1..1 uri Data Type or Resource (reference to definition) for this trigger definition
Binding: SubscriptionTypes (extensible): A type of resource, or a Reference (from all versions)
Additional BindingsPurpose
AllResourceTypes UI Binding
.... supportedInteraction SΣ 1..* code create | update | delete
Binding: InteractionTrigger (required): FHIR RESTful interaction used to filter a resource-based SubscriptionTopic trigger.
.... queryCriteria SΣ 0..1 BackboneElement Query based trigger rule
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... fhirPathCriteria SΣ 0..1 string FHIRPath based trigger rule
... canFilterBy SΣ 0..* BackboneElement Properties by which a Subscription can filter notifications from the SubscriptionTopic
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... filterParameter Σ 1..1 string Human-readable and computation-friendly name for a filter parameter usable by subscriptions on this topic, via Subscription.filterBy.filterParameter
... notificationShape SΣ 0..* BackboneElement Properties for describing the shape of notifications generated by this topic
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... resource Σ 1..1 uri URL of the Resource that is the focus (main) resource in a notification shape
Binding: SubscriptionTypes (extensible): A type of resource, or a Reference (from all versions)
Additional BindingsPurpose
AllResourceTypes UI Binding

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
SubscriptionTopic.status Base required PublicationStatus 📍5.0.0 FHIR Std.
SubscriptionTopic.jurisdiction Base extensible Jurisdiction ValueSet 📍5.0.0 FHIR Std.
SubscriptionTopic.resourceTrigger.​resource Base extensible Types used with Subscriptions 📍5.0.0 FHIR Std.
SubscriptionTopic.resourceTrigger.​supportedInteraction Base required Interaction Trigger 📍5.0.0 FHIR Std.
SubscriptionTopic.notificationShape.​resource Base extensible Types used with Subscriptions 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. SubscriptionTopic 0..* SubscriptionTopic The definition of a specific topic for triggering events within the Subscriptions framework
Interfaces Implemented: CanonicalResource
... url S 1..1 uri Canonical identifier for this subscription topic, represented as an absolute URI (globally unique)
... version S 0..1 string Business version of the subscription topic
... name S 1..1 string Name for this subscription topic (computer friendly)
... status S 1..1 code draft | active | retired | unknown
... experimental S 0..1 boolean If for testing purposes, not real usage
... date S 0..1 dateTime Date status first applied
... publisher S 0..1 string The name of the individual or organization that published the SubscriptionTopic
... description S 1..1 markdown Natural language description of the SubscriptionTopic
... jurisdiction S 0..* CodeableConcept Intended jurisdiction of the SubscriptionTopic (if applicable)
... purpose S 0..1 markdown Why this SubscriptionTopic is defined
... resourceTrigger S 1..* BackboneElement Definition of a resource-based trigger for the subscription topic
.... resource S 1..1 uri Data Type or Resource (reference to definition) for this trigger definition
.... supportedInteraction S 1..* code create | update | delete
.... queryCriteria S 0..1 BackboneElement Query based trigger rule
.... fhirPathCriteria S 0..1 string FHIRPath based trigger rule
... canFilterBy S 0..* BackboneElement Properties by which a Subscription can filter notifications from the SubscriptionTopic
... notificationShape S 0..* BackboneElement Properties for describing the shape of notifications generated by this topic

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. SubscriptionTopic 0..* SubscriptionTopic The definition of a specific topic for triggering events within the Subscriptions framework
Interfaces Implemented: CanonicalResource
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... url SΣ 1..1 uri Canonical identifier for this subscription topic, represented as an absolute URI (globally unique)
... identifier Σ 0..* Identifier Business identifier for subscription topic
... version SΣ 0..1 string Business version of the subscription topic
... versionAlgorithm[x] Σ 0..1 How to compare versions
Binding: VersionAlgorithm (extensible)
.... versionAlgorithmString string
.... versionAlgorithmCoding Coding
... name SΣ 1..1 string Name for this subscription topic (computer friendly)
... title SΣ 1..1 string Name for this subscription topic (human friendly)
... derivedFrom Σ 0..* canonical(SubscriptionTopic) Based on FHIR protocol or definition
... status ?!SΣ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
... experimental SΣ 0..1 boolean If for testing purposes, not real usage
... date SΣ 0..1 dateTime Date status first applied
... publisher SΣ 0..1 string The name of the individual or organization that published the SubscriptionTopic
... contact Σ 0..* ContactDetail Contact details for the publisher
... description S 1..1 markdown Natural language description of the SubscriptionTopic
... useContext Σ 0..* UsageContext Content intends to support these contexts
... jurisdiction SΣ 0..* CodeableConcept Intended jurisdiction of the SubscriptionTopic (if applicable)
Binding: JurisdictionValueSet (extensible): Countries and regions within which this artifact is targeted for use.
... purpose S 0..1 markdown Why this SubscriptionTopic is defined
... copyright 0..1 markdown Use and/or publishing restrictions
... copyrightLabel 0..1 string Copyright holder and year(s)
... approvalDate 0..1 date When SubscriptionTopic is/was approved by publisher
... lastReviewDate 0..1 date Date the Subscription Topic was last reviewed by the publisher
... effectivePeriod Σ 0..1 Period The effective date range for the SubscriptionTopic
... resourceTrigger SΣ 1..* BackboneElement Definition of a resource-based trigger for the subscription topic
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... description Σ 0..1 markdown Text representation of the resource trigger
.... resource SΣ 1..1 uri Data Type or Resource (reference to definition) for this trigger definition
Binding: SubscriptionTypes (extensible): A type of resource, or a Reference (from all versions)
Additional BindingsPurpose
AllResourceTypes UI Binding
.... supportedInteraction SΣ 1..* code create | update | delete
Binding: InteractionTrigger (required): FHIR RESTful interaction used to filter a resource-based SubscriptionTopic trigger.
.... queryCriteria SΣ 0..1 BackboneElement Query based trigger rule
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... previous Σ 0..1 string Rule applied to previous resource state
..... resultForCreate Σ 0..1 code test-passes | test-fails
Binding: CriteriaNotExistsBehavior (required): Behavior a server can exhibit when a criteria state does not exist (e.g., state prior to a create or after a delete).
..... current Σ 0..1 string Rule applied to current resource state
..... resultForDelete Σ 0..1 code test-passes | test-fails
Binding: CriteriaNotExistsBehavior (required): Behavior a server can exhibit when a criteria state does not exist (e.g., state prior to a create or after a delete).
..... requireBoth Σ 0..1 boolean Both must be true flag
.... fhirPathCriteria SΣ 0..1 string FHIRPath based trigger rule
... eventTrigger Σ 0..* BackboneElement Event definitions the SubscriptionTopic
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... description Σ 0..1 markdown Text representation of the event trigger
.... event Σ 1..1 CodeableConcept Event which can trigger a notification from the SubscriptionTopic
Binding: hl7VS-eventCode (example): FHIR Value set/code system definition for HL7 V2 table 0003 (EVENT TYPE CODE).
.... resource Σ 1..1 uri Data Type or Resource (reference to definition) for this trigger definition
Binding: SubscriptionTypes (extensible): A type of resource, or a Reference (from all versions)
Additional BindingsPurpose
AllResourceTypes UI Binding
... canFilterBy SΣ 0..* BackboneElement Properties by which a Subscription can filter notifications from the SubscriptionTopic
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... description Σ 0..1 markdown Description of this filter parameter
.... resource Σ 0..1 uri URL of the triggering Resource that this filter applies to
Binding: SubscriptionTypes (extensible): A type of resource, or a Reference (from all versions)
Additional BindingsPurpose
AllResourceTypes UI Binding
.... filterParameter Σ 1..1 string Human-readable and computation-friendly name for a filter parameter usable by subscriptions on this topic, via Subscription.filterBy.filterParameter
.... filterDefinition Σ 0..1 uri Canonical URL for a filterParameter definition
.... comparator 0..* code eq | ne | gt | lt | ge | le | sa | eb | ap
Binding: SearchComparator (required): Search Comparator Codes supported in this filter.
.... modifier 0..* code missing | exact | contains | not | text | in | not-in | below | above | type | identifier | of-type | code-text | text-advanced | iterate
Binding: SearchModifierCode (required): Search Modifier Codes supported in this filter.
... notificationShape SΣ 0..* BackboneElement Properties for describing the shape of notifications generated by this topic
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... resource Σ 1..1 uri URL of the Resource that is the focus (main) resource in a notification shape
Binding: SubscriptionTypes (extensible): A type of resource, or a Reference (from all versions)
Additional BindingsPurpose
AllResourceTypes UI Binding
.... include Σ 0..* string Include directives, rooted in the resource for this shape
.... revInclude Σ 0..* string Reverse include directives, rooted in the resource for this shape

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
SubscriptionTopic.language Base required All Languages 📍5.0.0 FHIR Std.
SubscriptionTopic.versionAlgorithm[x] Base extensible Version Algorithm 📍5.0.0 FHIR Std.
SubscriptionTopic.status Base required PublicationStatus 📍5.0.0 FHIR Std.
SubscriptionTopic.jurisdiction Base extensible Jurisdiction ValueSet 📍5.0.0 FHIR Std.
SubscriptionTopic.resourceTrigger.​resource Base extensible Types used with Subscriptions 📍5.0.0 FHIR Std.
SubscriptionTopic.resourceTrigger.​supportedInteraction Base required Interaction Trigger 📍5.0.0 FHIR Std.
SubscriptionTopic.resourceTrigger.​queryCriteria.resultForCreate Base required Criteria Not Exists Behavior 📍5.0.0 FHIR Std.
SubscriptionTopic.resourceTrigger.​queryCriteria.resultForDelete Base required Criteria Not Exists Behavior 📍5.0.0 FHIR Std.
SubscriptionTopic.eventTrigger.​event Base example hl7VS-eventCode 📦3.0.0 THO v7.1
SubscriptionTopic.eventTrigger.​resource Base extensible Types used with Subscriptions 📍5.0.0 FHIR Std.
SubscriptionTopic.canFilterBy.​resource Base extensible Types used with Subscriptions 📍5.0.0 FHIR Std.
SubscriptionTopic.canFilterBy.​comparator Base required Search Comparator 📍5.0.0 FHIR Std.
SubscriptionTopic.canFilterBy.​modifier Base required Search Modifier Code 📍5.0.0 FHIR Std.
SubscriptionTopic.notificationShape.​resource Base extensible Types used with Subscriptions 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

Summary

Mandatory: 5 elements
Must-Support: 18 elements

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. SubscriptionTopic 0..* SubscriptionTopic The definition of a specific topic for triggering events within the Subscriptions framework
Interfaces Implemented: CanonicalResource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... version SΣ 0..1 string Business version of the subscription topic
... name SΣ 1..1 string Name for this subscription topic (computer friendly)
... title SΣ 1..1 string Name for this subscription topic (human friendly)
... status ?!SΣ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
... experimental SΣ 0..1 boolean If for testing purposes, not real usage
... date SΣ 0..1 dateTime Date status first applied
... publisher SΣ 0..1 string The name of the individual or organization that published the SubscriptionTopic
... description S 1..1 markdown Natural language description of the SubscriptionTopic
... jurisdiction SΣ 0..* CodeableConcept Intended jurisdiction of the SubscriptionTopic (if applicable)
Binding: JurisdictionValueSet (extensible): Countries and regions within which this artifact is targeted for use.
... purpose S 0..1 markdown Why this SubscriptionTopic is defined
... resourceTrigger SΣ 1..* BackboneElement Definition of a resource-based trigger for the subscription topic
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... resource SΣ 1..1 uri Data Type or Resource (reference to definition) for this trigger definition
Binding: SubscriptionTypes (extensible): A type of resource, or a Reference (from all versions)
Additional BindingsPurpose
AllResourceTypes UI Binding
.... supportedInteraction SΣ 1..* code create | update | delete
Binding: InteractionTrigger (required): FHIR RESTful interaction used to filter a resource-based SubscriptionTopic trigger.
.... queryCriteria SΣ 0..1 BackboneElement Query based trigger rule
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... fhirPathCriteria SΣ 0..1 string FHIRPath based trigger rule
... canFilterBy SΣ 0..* BackboneElement Properties by which a Subscription can filter notifications from the SubscriptionTopic
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... filterParameter Σ 1..1 string Human-readable and computation-friendly name for a filter parameter usable by subscriptions on this topic, via Subscription.filterBy.filterParameter
... notificationShape SΣ 0..* BackboneElement Properties for describing the shape of notifications generated by this topic
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... resource Σ 1..1 uri URL of the Resource that is the focus (main) resource in a notification shape
Binding: SubscriptionTypes (extensible): A type of resource, or a Reference (from all versions)
Additional BindingsPurpose
AllResourceTypes UI Binding

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
SubscriptionTopic.status Base required PublicationStatus 📍5.0.0 FHIR Std.
SubscriptionTopic.jurisdiction Base extensible Jurisdiction ValueSet 📍5.0.0 FHIR Std.
SubscriptionTopic.resourceTrigger.​resource Base extensible Types used with Subscriptions 📍5.0.0 FHIR Std.
SubscriptionTopic.resourceTrigger.​supportedInteraction Base required Interaction Trigger 📍5.0.0 FHIR Std.
SubscriptionTopic.notificationShape.​resource Base extensible Types used with Subscriptions 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

Differential View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. SubscriptionTopic 0..* SubscriptionTopic The definition of a specific topic for triggering events within the Subscriptions framework
Interfaces Implemented: CanonicalResource
... url S 1..1 uri Canonical identifier for this subscription topic, represented as an absolute URI (globally unique)
... version S 0..1 string Business version of the subscription topic
... name S 1..1 string Name for this subscription topic (computer friendly)
... status S 1..1 code draft | active | retired | unknown
... experimental S 0..1 boolean If for testing purposes, not real usage
... date S 0..1 dateTime Date status first applied
... publisher S 0..1 string The name of the individual or organization that published the SubscriptionTopic
... description S 1..1 markdown Natural language description of the SubscriptionTopic
... jurisdiction S 0..* CodeableConcept Intended jurisdiction of the SubscriptionTopic (if applicable)
... purpose S 0..1 markdown Why this SubscriptionTopic is defined
... resourceTrigger S 1..* BackboneElement Definition of a resource-based trigger for the subscription topic
.... resource S 1..1 uri Data Type or Resource (reference to definition) for this trigger definition
.... supportedInteraction S 1..* code create | update | delete
.... queryCriteria S 0..1 BackboneElement Query based trigger rule
.... fhirPathCriteria S 0..1 string FHIRPath based trigger rule
... canFilterBy S 0..* BackboneElement Properties by which a Subscription can filter notifications from the SubscriptionTopic
... notificationShape S 0..* BackboneElement Properties for describing the shape of notifications generated by this topic

doco Documentation for this format

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. SubscriptionTopic 0..* SubscriptionTopic The definition of a specific topic for triggering events within the Subscriptions framework
Interfaces Implemented: CanonicalResource
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
... url SΣ 1..1 uri Canonical identifier for this subscription topic, represented as an absolute URI (globally unique)
... identifier Σ 0..* Identifier Business identifier for subscription topic
... version SΣ 0..1 string Business version of the subscription topic
... versionAlgorithm[x] Σ 0..1 How to compare versions
Binding: VersionAlgorithm (extensible)
.... versionAlgorithmString string
.... versionAlgorithmCoding Coding
... name SΣ 1..1 string Name for this subscription topic (computer friendly)
... title SΣ 1..1 string Name for this subscription topic (human friendly)
... derivedFrom Σ 0..* canonical(SubscriptionTopic) Based on FHIR protocol or definition
... status ?!SΣ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
... experimental SΣ 0..1 boolean If for testing purposes, not real usage
... date SΣ 0..1 dateTime Date status first applied
... publisher SΣ 0..1 string The name of the individual or organization that published the SubscriptionTopic
... contact Σ 0..* ContactDetail Contact details for the publisher
... description S 1..1 markdown Natural language description of the SubscriptionTopic
... useContext Σ 0..* UsageContext Content intends to support these contexts
... jurisdiction SΣ 0..* CodeableConcept Intended jurisdiction of the SubscriptionTopic (if applicable)
Binding: JurisdictionValueSet (extensible): Countries and regions within which this artifact is targeted for use.
... purpose S 0..1 markdown Why this SubscriptionTopic is defined
... copyright 0..1 markdown Use and/or publishing restrictions
... copyrightLabel 0..1 string Copyright holder and year(s)
... approvalDate 0..1 date When SubscriptionTopic is/was approved by publisher
... lastReviewDate 0..1 date Date the Subscription Topic was last reviewed by the publisher
... effectivePeriod Σ 0..1 Period The effective date range for the SubscriptionTopic
... resourceTrigger SΣ 1..* BackboneElement Definition of a resource-based trigger for the subscription topic
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... description Σ 0..1 markdown Text representation of the resource trigger
.... resource SΣ 1..1 uri Data Type or Resource (reference to definition) for this trigger definition
Binding: SubscriptionTypes (extensible): A type of resource, or a Reference (from all versions)
Additional BindingsPurpose
AllResourceTypes UI Binding
.... supportedInteraction SΣ 1..* code create | update | delete
Binding: InteractionTrigger (required): FHIR RESTful interaction used to filter a resource-based SubscriptionTopic trigger.
.... queryCriteria SΣ 0..1 BackboneElement Query based trigger rule
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... previous Σ 0..1 string Rule applied to previous resource state
..... resultForCreate Σ 0..1 code test-passes | test-fails
Binding: CriteriaNotExistsBehavior (required): Behavior a server can exhibit when a criteria state does not exist (e.g., state prior to a create or after a delete).
..... current Σ 0..1 string Rule applied to current resource state
..... resultForDelete Σ 0..1 code test-passes | test-fails
Binding: CriteriaNotExistsBehavior (required): Behavior a server can exhibit when a criteria state does not exist (e.g., state prior to a create or after a delete).
..... requireBoth Σ 0..1 boolean Both must be true flag
.... fhirPathCriteria SΣ 0..1 string FHIRPath based trigger rule
... eventTrigger Σ 0..* BackboneElement Event definitions the SubscriptionTopic
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... description Σ 0..1 markdown Text representation of the event trigger
.... event Σ 1..1 CodeableConcept Event which can trigger a notification from the SubscriptionTopic
Binding: hl7VS-eventCode (example): FHIR Value set/code system definition for HL7 V2 table 0003 (EVENT TYPE CODE).
.... resource Σ 1..1 uri Data Type or Resource (reference to definition) for this trigger definition
Binding: SubscriptionTypes (extensible): A type of resource, or a Reference (from all versions)
Additional BindingsPurpose
AllResourceTypes UI Binding
... canFilterBy SΣ 0..* BackboneElement Properties by which a Subscription can filter notifications from the SubscriptionTopic
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... description Σ 0..1 markdown Description of this filter parameter
.... resource Σ 0..1 uri URL of the triggering Resource that this filter applies to
Binding: SubscriptionTypes (extensible): A type of resource, or a Reference (from all versions)
Additional BindingsPurpose
AllResourceTypes UI Binding
.... filterParameter Σ 1..1 string Human-readable and computation-friendly name for a filter parameter usable by subscriptions on this topic, via Subscription.filterBy.filterParameter
.... filterDefinition Σ 0..1 uri Canonical URL for a filterParameter definition
.... comparator 0..* code eq | ne | gt | lt | ge | le | sa | eb | ap
Binding: SearchComparator (required): Search Comparator Codes supported in this filter.
.... modifier 0..* code missing | exact | contains | not | text | in | not-in | below | above | type | identifier | of-type | code-text | text-advanced | iterate
Binding: SearchModifierCode (required): Search Modifier Codes supported in this filter.
... notificationShape SΣ 0..* BackboneElement Properties for describing the shape of notifications generated by this topic
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... resource Σ 1..1 uri URL of the Resource that is the focus (main) resource in a notification shape
Binding: SubscriptionTypes (extensible): A type of resource, or a Reference (from all versions)
Additional BindingsPurpose
AllResourceTypes UI Binding
.... include Σ 0..* string Include directives, rooted in the resource for this shape
.... revInclude Σ 0..* string Reverse include directives, rooted in the resource for this shape

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
SubscriptionTopic.language Base required All Languages 📍5.0.0 FHIR Std.
SubscriptionTopic.versionAlgorithm[x] Base extensible Version Algorithm 📍5.0.0 FHIR Std.
SubscriptionTopic.status Base required PublicationStatus 📍5.0.0 FHIR Std.
SubscriptionTopic.jurisdiction Base extensible Jurisdiction ValueSet 📍5.0.0 FHIR Std.
SubscriptionTopic.resourceTrigger.​resource Base extensible Types used with Subscriptions 📍5.0.0 FHIR Std.
SubscriptionTopic.resourceTrigger.​supportedInteraction Base required Interaction Trigger 📍5.0.0 FHIR Std.
SubscriptionTopic.resourceTrigger.​queryCriteria.resultForCreate Base required Criteria Not Exists Behavior 📍5.0.0 FHIR Std.
SubscriptionTopic.resourceTrigger.​queryCriteria.resultForDelete Base required Criteria Not Exists Behavior 📍5.0.0 FHIR Std.
SubscriptionTopic.eventTrigger.​event Base example hl7VS-eventCode 📦3.0.0 THO v7.1
SubscriptionTopic.eventTrigger.​resource Base extensible Types used with Subscriptions 📍5.0.0 FHIR Std.
SubscriptionTopic.canFilterBy.​resource Base extensible Types used with Subscriptions 📍5.0.0 FHIR Std.
SubscriptionTopic.canFilterBy.​comparator Base required Search Comparator 📍5.0.0 FHIR Std.
SubscriptionTopic.canFilterBy.​modifier Base required Search Modifier Code 📍5.0.0 FHIR Std.
SubscriptionTopic.notificationShape.​resource Base extensible Types used with Subscriptions 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

Summary

Mandatory: 5 elements
Must-Support: 18 elements

 

Other representations of profile: CSV, Excel, Schematron